home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 4 / CU Amiga Magazine's Super CD-ROM 04 (1996)(EMAP Images)(GB)(Track 1 of 3)[!][issue 1996-11].iso / magazine / psion / utils / readme.3a < prev    next >
Text File  |  1996-09-19  |  9KB  |  204 lines
  1.                 ELVIS for the Psion 3a and Compatibles
  2.                 ======================================
  3.                            4th October 1995
  4.                     Psion 3a version - 5th release
  5.         
  6.         INTRODUCTION
  7.         ~~~~~~~~~~~~
  8.         This information is intended to provide information
  9.         that is specific to the Psion 3a implementation of ELVIS.
  10.  
  11.         ELVIS was ported to the Psion 3a by Keith and Dave Walker.
  12.         The port is based on the ELVIS v1.8 patch level 3 source.
  13.         The key features of this port are:
  14.  
  15.           -  Full command level compatibility with the Unix "vi"
  16.              program so that users of "vi" will instantly be able
  17.              to use the ELVIS program.
  18.  
  19.           -  The ability to edit larger files than arem possible
  20.              with the Text Editor built into the Psion 3a.  The
  21.              file size is limited only by the size of the RAM
  22.              disk that you can give to ELVIS to create its
  23.              temporary files on.
  24.  
  25.         The port was done to provide us with an alternative text
  26.         editor to that built into the Psion 3a that was more
  27.         suitable to editing and amending source code files. This
  28.         was done as part of developing a complete C development
  29.         system hosted on the Psion 3a.  We intend to release this
  30.         C development system shortly under the name of CPOC (which
  31.         is a play on EPOC as the name of the Psion operating system
  32.         and "C in your POCket" as a description of the capability).
  33.  
  34.  
  35.         INSTALLATION AND RUNNING
  36.         ~~~~~~~~~~~~~~~~~~~~~~~~
  37.         The files provided are as follows:
  38.  
  39.             README              The original ELVIS README file
  40.             README.3a           Psion 3a specific information
  41.             ELVIS.APP           The ELVIS program itself
  42.             ELVIS.INI           Sample initialisation file
  43.  
  44.     The ELVIS.APP file requires about 128K of system memory to run (64K
  45.     code and 64K data).  It is therefore only really suitable for
  46.     running on the larger Psion S3a models or one which has been
  47.     expanded with SSDs.
  48.  
  49.         The ELVIS.APP file can be installed in any directory that
  50.         you like.   We would recommend that you put it into either
  51.         the "\APP\" directory or the "\CPOC\" directory on any drive.
  52.         If it is placed in this location it will automatically be
  53.         integrated into the CPOC system when it becomes available.
  54.  
  55.         You can install ELVIS using the standard Psion-I sequence.
  56.         As supplied, ELVIS will look for files in the \TXT directory
  57.         on any drive that have a .TXT extension.  By making use of
  58.         list facility you can specify alternative file locations and
  59.         file extensions.  This is mentioned in section 16 of the
  60.         User Guide manual (the chapter called "The System Screen").
  61.  
  62.         If you have a command line processor (such as the CMDP package
  63.         released by Psion) then you can also start ELVIS (or one of
  64.         its aliases) from the command line.  You will need to specify
  65.         the full path name if you do not want to use the default one.
  66.  
  67.         Finally, if you have already loaded ELVIS you can use one of the
  68.         built in ELVIS commands (such as the "r" or "e" commands) to load
  69.         the required file.
  70.  
  71.  
  72.         TEMPORARY FILE
  73.         ~~~~~~~~~~~~~~
  74.         While ELVIS is editing a file, it uses a temporary file to
  75.         keep track of all the changes that you are making.  The
  76.         location of this temporary file is decided as follows:
  77.  
  78.           -  If the ELVIS initialisation file exists (see below) and
  79.              it contains a line such for the form
  80.                  set directory=A:\TMP\
  81.              then this is used as the location of temporary files.
  82.  
  83.           -  If the ELVIS initialisation file does not exist and
  84.              if the "TMP" or "TEMP" environment variables are set
  85.              then the directory that they point to is used for the
  86.              ELVIS temporary files.
  87.  
  88.           -  If none of the above are true then ELVIS will assume the
  89.              location "\"  (i.e. the root directory of the default
  90.              drive) is to be used for temporary files.
  91.  
  92.         It is the users responsibility to ensure that the relevant
  93.         directory for temporary files does in fact exist.  If it does
  94.         not, then ELVIS will fail while loading.
  95.  
  96.  
  97.         INITIALISATION FILE
  98.         ~~~~~~~~~~~~~~~~~~~
  99.         The normal "vi" editor when running on a Unix system allows
  100.         you to set up a file called ".exrc" that holds start up
  101.         configuration details.   The Psion 3a port of ELVIS uses
  102.         a file called "ELVIS.INI" instead.   This file (if present)
  103.         is expected to be a text file that is held in the same
  104.         directory as the ELVIS.APP file.
  105.  
  106.         This file is normally the easiest way to specify the location
  107.         for the ELVIS temporary files.   You can create an initial
  108.         ELVIS.INI file by loading the WORD application built into the
  109.         Psion 3a and saving the resulting file as file of type "TEXT".
  110.         Subsequently you can use ELVIS itself to edit the ELVIS.INI
  111.         file.
  112.  
  113.         To make it easier for you, we have provided a sample ELVIS.INI
  114.         file.  You can use this as a starting point, and tailor it to
  115.         suit you particular system and preferences.
  116.  
  117.     There is a psion specific numeric variable called fontindex (fi)
  118.     which can be used to specify the size of the font to be used.
  119.     The variable can take a value between 0 and 4, the values
  120.     representing the font sizes 6-point, 8-point, 11-point, 13-point
  121.     and 16-point.   By using this variable in the ELCIS.INI file it
  122.     is possible to specify which font to use on startup.
  123.  
  124.         DOCUMENTATION
  125.         ~~~~~~~~~~~~~
  126.         The author of ELVIS provides a full manual on its use and
  127.         facilities (about 120 pages).  This manual is provided in
  128.         the Unix ROFF format.  If you want the raw ROFF format
  129.         version of the documentation, then it is widely avaiable on
  130.         one of the many Internet sites that hold ELVIS source.  A
  131.         good site in the UK is "ic.ac.uk" (Imperial College).
  132.  
  133.         For Psion users, we have processed the ROFF format documentation
  134.         files to produce a single formatted text file  (about 200Kb
  135.         in size).  As we expect many of the typical users of ELVIS
  136.         to already be familiar with the "vi" program, we have not
  137.         included this documentation in the same package as the main
  138.         ELVIS application program, but instead made it a separate file
  139.         that you only need to download if you want it.
  140.  
  141.  
  142.         CHANGING FONT SIZE
  143.         ~~~~~~~~~~~~~~~~~~
  144.         A special feature of the Psion port is the support for a range
  145.         of different font sizes.   You can toggle round the available
  146.         fonts by using the Psion-Z keypress (or Psion-Hift-Znto go the
  147.         other way).
  148.  
  149.         There is also a new 'set' option so that you can add your
  150.         favourite font setup to the ELVIS.INI file.  This 'set' option
  151.         uses the keyword 'fontindex' (abbreviation is'fi') followed
  152.         by a numeric value to specify the font.  The values supported
  153.         are:
  154.             0     6 point monospace font
  155.             1     8 point Swiss font
  156.             2     11 point Swiss font
  157.             3     13 point Swiss font
  158.             4     15 point Swiss font
  159.         As you change the font size, the number of lines on the screen
  160.         and the number of columns will be automatically adjusted to fit
  161.         into the available screen area.
  162.  
  163.         You can find out the current settings of the fontindex and the
  164.         number of screen ros and columns at any time by using the 'set'
  165.         command with no parameters.
  166.  
  167.  
  168.         LIMITATIONS
  169.         ~~~~~~~~~~~
  170.         At this release we have not ported to the 3a the ancilliary
  171.         programs that can be used in conjunction with ELVIS.  These
  172.         include programs such as "FORMAT" and "TAGS".  Therefore
  173.         any command which depend on the presence of such ancilliary
  174.         programs will not work.  Also the Psion 3a does not have a
  175.         command shell, so the colon mode "!" command will not work.
  176.  
  177.  
  178.         CHANGE HISTORY
  179.         ~~~~~~~~~~~~~~
  180.         20 July 1995    Initial release for the Psion 3a
  181.  
  182.         13 Aug 1995   - ELVIS program now a file based ".APP" file.
  183.                       - Faster screen updating.
  184.                       - The Temporary directory changed to default to
  185.                         the root directory of the current default drive.
  186.  
  187.     15 Aug 1995   - After a :e, :n or :f command the file being edited
  188.             is updated on the system screen.
  189.  
  190.     20 Aug 1995   - Fixed the X p N and , commands (porting problem).
  191.             Updated :version command with Psion release info.
  192.             Moved messages into a resource file - frees
  193.             about 5K in data area.
  194.             :sh command now actualy runs contents of shell
  195.             variable (but :!command still doesn't work)
  196.  
  197.     04 Oct 1995   -    Psion-X writes file and exits elvis
  198.             Shift-Psion-X exits elvis with no write
  199.             Delete key on system screen now handled
  200.             Elvis now goes "busy" when performing long task.
  201.             (Shift-)Psion-Z changes font size.
  202.             new :set variable fontindex
  203.             fixed a couple of messages.
  204.